Skip to content

Make Python README standalone and auto-download example data#27

Closed
iahncajigas wants to merge 1 commit intomainfrom
codex/readme-standalone-example-data
Closed

Make Python README standalone and auto-download example data#27
iahncajigas wants to merge 1 commit intomainfrom
codex/readme-standalone-example-data

Conversation

@iahncajigas
Copy link
Copy Markdown
Contributor

@iahncajigas iahncajigas commented Mar 7, 2026

Summary

  • rewrite the README to mirror the MATLAB repo structure while keeping the Python toolbox standalone
  • make example-data access auto-download the figshare dataset on first use
  • update install/data docs and tests for the new behavior

Verification

  • pytest tests/test_install_and_compat.py tests/test_datasets.py tests/test_readme_examples_catalog.py tests/test_readme_nstatpaperexamples.py

@iahncajigas
Copy link
Copy Markdown
Contributor Author

iahncajigas commented Mar 11, 2026

Closing: superseded by README updates in v0.3.0 (commits 3b82163, ec75482, e11b6ff). The README now matches the Matlab repo structure with overview, lab links, license, Figshare DOI, PMID, and cross-references.

@iahncajigas iahncajigas deleted the codex/readme-standalone-example-data branch March 11, 2026 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@iahncajigas